Add tables.load docstring#3453
Conversation
hyanwong
force-pushed
the
doc-tables-load
branch
from
cb29631 to
5af5c97
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3453 +/- ##
=======================================
Coverage 91.66% 91.66%
=======================================
Files 38 38
Lines 32184 32184
Branches 5150 5150
=======================================
Hits 29503 29503
Misses 2348 2348
Partials 333 333
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
| """ | ||
| Load a TableCollection from a file or path, saved in the format defined by | ||
| :meth:`.dump`. If the file is not in a valid format, an exception will be | ||
| raised. |
There was a problem hiding this comment.
This doesn't do any validation, right? (e.g., doing tables.tree_sequence() might produce an error) This would be a useful thing to point out here, since that's one of the main uses for this function (loading up tables that don't validate).
There was a problem hiding this comment.
Correct -- no validation happens. The relevant logic is line 4943 of _tskitmodule.c.
There was a problem hiding this comment.
Yeah, great point. I will add that comment
|
I think we can merge this; sound good? |
|
Great - I just clicked the merge button. |
3 participants
Fixes #3406